-
-
Notifications
You must be signed in to change notification settings - Fork 167
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOC: Solve Dependencies Conflicts and pyproject build #613
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #613 +/- ##
========================================
Coverage 73.56% 73.56%
========================================
Files 70 70
Lines 10313 10313
========================================
Hits 7587 7587
Misses 2726 2726 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Really nice PR, thanks for the solution.
Would you mind adding a comment to ~ somewhere I don't know ~ saying that you need to run pip-compile ...
to generate the requirements.txt file now?
Maybe at the top of the requirements.in
?
All tests are passing in the CI. I'm approving the PR, can be merged already I think.
There are some comments added automatically at the top of I don't know if you have seen those, but if you think that it is not enough, I can add a line on top of |
OK, Good, that's enough, I haven't seen those before. |
Pull request type
Checklist
black rocketpy/ tests/
) has passed locallypytest tests -m slow --runslow
) have passed locallyCHANGELOG.md
has been updated (if relevant)Note:
--runslow
is currently failing.Current behavior
An error occurs while trying building docs due to many reasons, including:
docutils
not supported bym2r2
;pyproject.toml
requiresconf.py
changes;lxml
separated itshtml_clean
to another repo for security.All those library changes happened around late april and beginning of may.
New behavior
The following changes were made:
docutils
version to0.20.1
;docs/requirements
the newlxml_html_clean
;PYTHONPATH
toconf.py
.Following sphinx docs recommendation, in order to avoid breaking docs due to dependency updates
pip-tools
was used to pin down all docs dependencies.The following procedure should be followed to add/update a docs dependency:
docs/requirements.in
;pip-compile docs/requirements.in
.Docs are building now:
![image](https://github.com/RocketPy-Team/RocketPy/assets/87212571/3edb37d1-ec8a-48ab-b7ee-e13fa75e0137)Breaking change
Additional information
The PR #584 removes
README.md
from the docs, allowing the removal ofm2r2
dependency and the limitation ofdocutils
version.